<!DOCTYPE html>
<html lang="en">

<head>
  <meta charset="UTF-8">
  <title>OpenLayers v8.2.0 API - Module: ol/control/defaults</title>
  <script src="scripts/prettify/prettify.js"></script>
  <script src="scripts/prettify/lang-css.js"></script>
  <script src="https://code.jquery.com/jquery-3.6.0.min.js" crossorigin="anonymous"></script>
  <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.2.0/dist/js/bootstrap.bundle.min.js"
    crossorigin="anonymous"></script>
  <link rel="stylesheet" type="text/css" href="https://cdn.jsdelivr.net/npm/bootstrap@5.2.0/dist/css/bootstrap.min.css"
    crossorigin="anonymous">
  <link rel="stylesheet" type="text/css"
    href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.1.2/css/fontawesome.min.css"
    crossorigin="anonymous">
  <link rel="stylesheet" type="text/css"
    href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.1.2/css/solid.css" crossorigin="anonymous">
  <link rel="stylesheet" type="text/css"
    href="https://cdn.jsdelivr.net/npm/@fortawesome/fontawesome-free@6.1.2/css/brands.css" crossorigin="anonymous">
  <link rel="stylesheet" type="text/css" href="styles/prettify-tomorrow.css">
  <link rel="stylesheet" type="text/css" href="styles/jaguar.css">
  <link rel="stylesheet" type="text/css" href="styles/carbon.css">
  <link rel="stylesheet" type="text/css" href="/theme/ol.css">
  <link rel="stylesheet" type="text/css" href="/theme/site.css">
</head>

<body>
  <header class="navbar navbar-expand-sm navbar-dark mb-3 px-3 py-0 fixed-top" role="navigation">
    <a class="navbar-brand" href="/"><img src="/theme/img/logo-dark.svg" width="70" height="70"
        alt="">&nbsp;OpenLayers</a>
    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#olmenu"
      aria-controls="olmenu" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <!-- menu items that get hidden below 768px width -->
    <nav class="collapse navbar-collapse" id="olmenu">
      <ul class="nav navbar-nav ms-auto">
        <li class="nav-item dropdown">
          <a class="nav-link dropdown-toggle" href="#" id="docdropdown" role="button" data-bs-toggle="dropdown"
            aria-haspopup="true" aria-expanded="false">Docs</a>
          <div class="dropdown-menu dropdown-menu-end mb-3" aria-labelledby="docdropdown">
            <a class="dropdown-item" href="/doc/">Docs</a>
            <div class="dropdown-divider"></div>
            <a class="dropdown-item" href="/doc/quickstart.html"><i class="fa fa-check fa-fw me-2 fa-lg"></i>快速入门</a>
            <a class="dropdown-item" href="/doc/faq.html"><i class="fa fa-question fa-fw me-2 fa-lg"></i>常见问题</a>
            <a class="dropdown-item" href="/doc/tutorials/"><i class="fa fa-book fa-fw me-2 fa-lg"></i>教程</a>

          </div>
        </li>
        <li class="nav-item"><a class="nav-link" href="/en/latest/examples/">Examples</a></li>
        <li class="nav-item dropdown">
          <a class="nav-link dropdown-toggle" href="#" id="apidropdown" role="button" data-bs-toggle="dropdown"
            aria-haspopup="true" aria-expanded="false">
            <i class="fa fa-sitemap me-1"></i>API
          </a>
          <div class="dropdown-menu dropdown-menu-end mb-3" aria-labelledby="apidropdown">
            <a class="dropdown-item" href="/en/latest/apidoc/"><i class="fa fa-sitemap fa-fw me-2 fa-lg"></i>v8.2.0
              (latest)</a </div>
        </li>
      </ul>
    </nav>
  </header>

  <div class="container-fluid">
    <div id="wrap" class="row">
      <div class="navigation col-md-4 col-lg-3">
        <div class="search-wrapper">
          <div class="search">
            <input id="search" type="text" autocomplete="off" class="form-control input-sm"
              placeholder="Search Documentation">
          </div>
        </div>
        <div class="navigation-list-wrapper">
          <ul class="navigation-list search-empty">
            <li class="item item-module toggle-manual toggle-manual-show" data-longname="module:ol/control/defaults"
              data-name="ol/control/defaults">
              <span class="title toggle">
                <span class="fa fa-plus me-2 mt-1"></span>
                <span><a href="module-ol_control_defaults.html">ol​/control​/defaults</a></span>
              </span>
              <div class="member-list" data-type="typedefs">
                <span class="subtitle">Typedefs</span>
                <ul>
                  <li data-name="defaultsoptions"><a
                      href="module-ol_control_defaults.html#~DefaultsOptions">DefaultsOptions</a>
                </ul>
              </div>
              <div class="member-list" data-type="methods">
                <span class="subtitle">Methods</span>
                <ul>
                  <li data-name="defaults"><a href="module-ol_control_defaults.html#.defaults">defaults</a>
                </ul>
              </div>
            <li class="loading">Loading …
          </ul>
        </div>
      </div>

      <div class="main col-md-8 col-lg-9">
        <h1 class="page-title" data-filename="module-ol_control_defaults.html">Module: ol/control/defaults</h1>
        <div id="latest-check" class="alert alert-warning alert-dismissible" role="alert" style="display:none">
          <button id="latest-dismiss" type="button" class="btn-close" data-bs-dismiss="alert"
            aria-label="Close"></button>
          This documentation is for OpenLayers v<span id="package-version">8.2.0</span>. The <a id="latest-link"
            href="#" class="alert-link">latest</a> is v<span id="latest-version"></span>.
        </div>




        <section class="content">

          <header>
            <h2 class="my-3">ol/control/defaults
            </h2>
            <br>




            <div class="row p-3 ">
              <!-- <div id="ad" class="col-lg-5 order-2 align-self-center border rounded bg-light ">
                <script async type="text/javascript"
                  src="https://cdn.carbonads.com/carbon.js?serve=CE7DV53U&placement=openlayersorg"
                  id="_carbonads_js"></script>
              </div> -->

            </div>
          </header>

          <article>
            <div class="container-overview">






              <dl class="details">





















              </dl>




            </div>


















            <h3 class="subsection-title">Functions</h3>

            <dl>


              <dt class="">

                <div class="nameContainer">
                  <div class="anchor" id=".defaults">
                  </div>
                  <h4 class="name">
                    defaults<span class="signature">(<span class="optional">options</span>)</span><span
                      class="fa fa-arrow-circle-right"></span><span class="type-signature returnType">{<a
                        href="module-ol_Collection-Collection.html">Collection</a>&lt;<a
                        href="module-ol_control_Control-Control.html">Control</a>>}</span>



                  </h4>

                  <div class="tag-source">
                    <a
                      href="https://github.com/openlayers/openlayers/blob/v8.2.0/src/ol/control/defaults.js">control/defaults.js</a>,
                    <a href="https://github.com/openlayers/openlayers/blob/v8.2.0/src/ol/control/defaults.js#L37">line
                      37</a>
                  </div>

                </div>


              </dt>
              <dd class="">



                <pre class="prettyprint source"><code>import {defaults} from 'ol/control/defaults';</code></pre>



                <div class="description">
                  <p>默认情况下包含在地图中的控件集合。除非进行其他配置，否则此方法返回一个包含以下控件实例的集合：</p>
                  <ul>
                    <li><a href="module-ol_control_Zoom-Zoom.html"><code>Zoom</code></a></li>
                    <li><a href="module-ol_control_Rotate-Rotate.html"><code>Rotate</code></a></li>
                    <li><a href="module-ol_control_Attribution-Attribution.html"><code>Attribution</code></a></li>
                  </ul>
                </div>










                <table class="params">
                  <thead>
                    <tr>

                      <th>Name</th>


                      <th>Type</th>

                      <th class="last">Description</th>
                    </tr>
                  </thead>

                  <tbody>


                    <tr class="">

                      <td class="name"><code>attribution</code></td>



                      <td class="type">


                        <span class="param-type">boolean</span>



                        (defaults to true)


                      </td>



                      <td class="description last">

                        <p>包含
                          <a href="module-ol_control_Attribution-Attribution.html"><code>归属</code></a>.
                        </p>
                      </td>
                    </tr>



                    <tr class="">

                      <td class="name"><code>attributionOptions</code></td>



                      <td class="type">


                        <span class="param-type"><a
                            href="module-ol_control_Attribution.html#~Options">Options</a></span>

                        | undefined


                      </td>



                      <td class="description last">

                        <p> <a href="module-ol_control_Attribution-Attribution.html"><code>归属</code></a>选项。</p>
                      </td>
                    </tr>



                    <tr class="">

                      <td class="name"><code>rotate</code></td>



                      <td class="type">


                        <span class="param-type">boolean</span>



                        (defaults to true)


                      </td>



                      <td class="description last">

                        <p>包括
                          <a href="module-ol_control_Rotate-Rotate.html"><code>旋转</code></a>.
                        </p>
                      </td>
                    </tr>



                    <tr class="">

                      <td class="name"><code>rotateOptions</code></td>



                      <td class="type">


                        <span class="param-type"><a href="module-ol_control_Rotate.html#~Options">Options</a></span>

                        | undefined


                      </td>



                      <td class="description last">

                        <p><a href="module-ol_control_Rotate-Rotate.html"><code>旋转</code></a>选项。</p>
                      </td>
                    </tr>



                    <tr class="">

                      <td class="name"><code>zoom</code></td>



                      <td class="type">


                        <span class="param-type">boolean</span>

                        | undefined


                      </td>



                      <td class="description last">

                        <p>Include <a href="module-ol_control_Zoom-Zoom.html"><code>Zoom</code></a>.</p>
                      </td>
                    </tr>



                    <tr class="">

                      <td class="name"><code>zoomOptions</code></td>



                      <td class="type">


                        <span class="param-type"><a href="module-ol_control_Zoom.html#~Options">Options</a></span>

                        | undefined


                      </td>



                      <td class="description last">

                        <p>Options for
                          <a href="module-ol_control_Zoom-Zoom.html"><code>Zoom</code></a>.
                        </p>
                      </td>
                    </tr>


                  </tbody>
                </table>




                <dl class="details">





















                </dl>















                <h5>Returns:</h5>
                与<a href="module-ol_Map-Map.html"><code>Map</code></a>构造器的<code>controls</code>选项一起使用的控件集合。
                <br />




              </dd>

            </dl>



            <h3 class="subsection-title">Type Definitions</h3>

            <dl>

              <dt class="">
                <div class="nameContainer">
                  <div class="anchor" id="~DefaultsOptions">
                  </div>
                  <h4 class="name">
                    DefaultsOptions<span class="type-signature type object">{Object}</span>


                  </h4>
                </div>

              </dt>
              <dd class="">



                <dl class="details">


                  <h5 class="subsection-title">Properties:</h5>

                  <dl>

                    <table class="props">
                      <thead>
                        <tr>

                          <th>Name</th>


                          <th>Type</th>

                          <th class="last">Description</th>
                        </tr>
                      </thead>

                      <tbody>


                        <tr>

                          <td class="name"><code>attribution</code></td>


                          <td class="type">


                            <span class="param-type">boolean</span>



                            <br>(defaults to true)


                          </td>

                          <td class="description last">
                            <p>Include
                              <a href="module-ol_control_Attribution-Attribution.html"><code>Attribution</code></a>.
                            </p>

                          </td>
                        </tr>



                        <tr>

                          <td class="name"><code>attributionOptions</code></td>


                          <td class="type">


                            <span class="param-type"><a
                                href="module-ol_control_Attribution.html#~Options">Options</a></span>

                            | undefined


                          </td>

                          <td class="description last">
                            <p>Options for <a
                                href="module-ol_control_Attribution-Attribution.html"><code>Attribution</code></a>.</p>

                          </td>
                        </tr>



                        <tr>

                          <td class="name"><code>rotate</code></td>


                          <td class="type">


                            <span class="param-type">boolean</span>



                            <br>(defaults to true)


                          </td>

                          <td class="description last">
                            <p>Include
                              <a href="module-ol_control_Rotate-Rotate.html"><code>Rotate</code></a>.
                            </p>

                          </td>
                        </tr>



                        <tr>

                          <td class="name"><code>rotateOptions</code></td>


                          <td class="type">


                            <span class="param-type"><a href="module-ol_control_Rotate.html#~Options">Options</a></span>

                            | undefined


                          </td>

                          <td class="description last">
                            <p>Options
                              for <a href="module-ol_control_Rotate-Rotate.html"><code>Rotate</code></a>.</p>

                          </td>
                        </tr>



                        <tr>

                          <td class="name"><code>zoom</code></td>


                          <td class="type">


                            <span class="param-type">boolean</span>

                            | undefined


                          </td>

                          <td class="description last">
                            <p>Include <a href="module-ol_control_Zoom-Zoom.html"><code>Zoom</code></a>.</p>

                          </td>
                        </tr>



                        <tr>

                          <td class="name"><code>zoomOptions</code></td>


                          <td class="type">


                            <span class="param-type"><a href="module-ol_control_Zoom.html#~Options">Options</a></span>

                            | undefined


                          </td>

                          <td class="description last">
                            <p>Options for
                              <a href="module-ol_control_Zoom-Zoom.html"><code>Zoom</code></a>.
                            </p>

                          </td>
                        </tr>


                      </tbody>
                    </table>
                  </dl>






















                </dl>



              </dd>

            </dl>



          </article>

        </section>




      </div>
    </div>
  </div>
  <script>prettyPrint();</script>
  <script src="scripts/linenumber.js"></script>
  <script src="scripts/main.js"></script>
</body>

</html>